SetIndexedCollectionItemInfo

SetIndexedCollectionItemInfo
Header:	Collections.h		Carbon status:	Supported

Edits the attributes of a specific collection item given the item’s collection index.

OSErr SetIndexedCollectionItemInfo (
    Collection c, 
    SInt32 index, 
    SInt32 whichAttributes, 
    SInt32 newAttributes
);

c: A reference to the collection object containing the item whose attributes you want to edit. The behavior of this function is undefined if you do not provide a reference to a valid collection object.
index: The collection index of the item whose attributes you want to edit.
whichAttributes: A mask indicating which attributes you want to edit.
newAttributes: An SInt32 word containing the new settings for the attributes.

function result: A result code.

DISCUSSION

The SetIndexedCollectionItemInfo function copies bit values from the newAttributes parameter to the attributes associated with the specified item.

This function uses the whichAttributes parameter to determine which bits to copy. For every bit in the whichAttributes parameter, this function takes one of two actions:

If the bit is set, this function copies the value of the corresponding bit from the newAttributes parameter into the corresponding bit of the attributes associated with the specified item.
If the bit is not set, the corresponding bit of the specified item’s attributes remains unchanged.

The whichAttributes parameter allows you to change the values of specific bits in the specified item’s attributes without affecting the values of other bits.

To edit the attributes of collection item using the collection tag and collection ID (rather than the collection index) to specify the item, use the SetCollectionItemInfo function.

To examine the attributes of a collection item, use the functions GetCollectionItemInfo, GetIndexedCollectionItemInfo, and GetTaggedCollectionItemInfo.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.